chore: improve changelog by using git-cliff
#768
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vjousse
force-pushed
the
chore/improve-changelog
branch
3 times, most recently
from
79c5299
to
1283e08
Compare
vjousse
force-pushed
the
chore/improve-changelog
branch
2 times, most recently
from
33e704b
to
11f8e9e
Compare
vjousse
added a commit
that referenced
this pull request
Sep 26, 2024
## 🔧 Problem When deploying on scalingo we download all releases without checking if it's a draft one, it may cause problems if we want to use the draft functionality of releases to use `git-cliff` for example #768. ## 🍰 Solution Filter out releases that are draft. ## 🏝️ How to test The deploy to scalingo of this PR should download 11 releases and not more (we currently have 11 releases and some drafts).
vjousse
force-pushed
the
chore/improve-changelog
branch
from
d6d16b8
to
01242be
Compare
vjousse
force-pushed
the
chore/improve-changelog
branch
4 times, most recently
from
c99829b
to
6fa522a
Compare
vjousse
changed the title
git-cliffgit-cliff
vjousse
force-pushed
the
chore/improve-changelog
branch
from
8191c1d
to
76336df
Compare
n1k0
approved these changes
Oct 9, 2024
cliff.toml
Outdated
| # regex for parsing and grouping commits | ||
| commit_parsers = [ | ||
| { message = "^feat", group = "<!-- 0 -->🚀 Features" }, | ||
| { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" }, |
There was a problem hiding this comment.
nit: May I suggest 🪲 as it's what's already used in Notion, for consistency?
vjousse
pushed a commit
that referenced
this pull request
Oct 10, 2024
## [2.4.0](https://github.com/MTES-MCT/ecobalyse/compare/v2.3.0..v2.4.0) (2024-10-10) ### 🚀 Features - Introduce first version of object interface ([#756](#756)) ### 🪲 Bug Fixes - Sync food ([#759](#759)) - Don't hide version information on staging ([#778](#778)) - Reset physical durablility in regulatory mode ([#786](#786)) - *(api,food)* Nullable fields weren't nullable anymore. ([#789](#789)) ### 🚜 Refactor - Small textile explorer improvements ([#773](#773)) ### ⚙️ Miscellaneous Tasks - Don't download draft releases ([#771](#771)) - Remove `airTransportRatio` from examples ([#785](#785)) - Cleanup package-lock.json. ([#787](#787)) - Use builtin python action cache for pipenv ([#796](#796)) - Improve changelog by using `git-cliff` ([#768](#768)) <!-- generated by git-cliff --> Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Problem
We can't customize the changelog generated by release-please, so it's impossible to filter technical and non technical changes.
Moreover only
fixandfeatcommits are parts of the changelog, sometimes it would make sense to addchore,refactoranddocchanges to the changelog.🍰 Solution
Use
git-cliffto generate the changelog and create the tags too. The process is the same than withrelease-please, it will create an automated PR that, when merged, will tag the appropriate version and create a release.🚨 Points to watch/comments
Commits that are only relative to
data/are excluded from the changelog.We will be able to fully test this PR only once it will be merged into master and once a release will be created. I did all the tests that I could without merging, see below.
🏝️ How to test
The generated PR will look like this one: #797
Important
This automated PR was updated using the commits of this PR, so once this is merged into
master, the changelog will only contain the squashed commits of themasterbranch.The different workflows were tested extensively here: https://github.com/vjousse/git-cliff-release-creation-exemple
I did a test on this PR by enabling release creation on commit push here (instead of merging the changelog PR). The tag and the release (configured as draft in my test) was created as expected, see the screenshots below.
I have removed the tag and the draft PR since.